home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / wfs203.zip / HELP.TXT < prev    next >
Text File  |  1992-10-27  |  7KB  |  246 lines
  1.  
  2.             Message Command Language
  3.  
  4.  
  5. There are some general rules for commands:
  6.  
  7. o   Commands and operands are, in general, not case sensitive;
  8.     the operand of the "password" command is case sensitive.
  9.  
  10. o   Leading spaces are permitted before the command. Commands
  11.     must be the first token on a line.
  12.  
  13. o   A '#' character as the first character on a line is treated
  14.     as a comment. The line does not cause an error.
  15.  
  16. o   A line beginning with the string "--" is treated as end of
  17.     input. The remainder of the message is ignored.
  18.  
  19.  
  20. 2.1  The HELP Command
  21.  
  22. The HELP command causes WFS to send the file identified via the
  23. "wfs.help" statement in Waffle's static file. The file is
  24. included in the session transcript.
  25.  
  26. Anything after the HELP on the line is ignored.
  27.  
  28. The SysOp may selectively enable and optionally assign multiple
  29. aliases for the HELP command using the wfs.enable.help static
  30. file statement.
  31.  
  32.  
  33. 2.2  The DIR Command
  34.  
  35. The DIR command causes WFS to send the file identified via the
  36. "wfs.filelist" statement in Waffle's static file. The request for
  37. the directory is queued for later transmission.
  38.  
  39. Anything after the DIR on the line is ignored.
  40.  
  41. The SysOp may assign multiple names for the DIR command using the
  42. wfs.enable.dir static file statement.
  43.  
  44.  
  45. 2.3  The NEWFILES Command
  46.  
  47. The NEWFILES command causes WFS to send a list of files newer
  48. that the user specified date. The request for NEWFILES is queued
  49. like a the DIR request.
  50.  
  51. The systax for the NEWFILES command is:
  52.  
  53.      NEWFILES <date>
  54.  
  55. <date> is required. <date> has the form of mm-dd-yy. WFS is
  56. strict about checking the form of <date>; if it does not look
  57. like it expects, the command will be rejected.
  58.  
  59. A valid specification for the NEWFILES command is:
  60.  
  61.      NEWFILES 02-15-92
  62.  
  63. The SysOp may selectively enable and optionally assign multiple
  64. aliases for the NEWFILES command using the wfs.enable.newfiles
  65. static file statement.
  66.  
  67.  
  68. 2.4  The GET Command
  69.  
  70. The GET command causes WFS to send a file to the requestor.
  71.  
  72. The syntax for the GET command is:
  73.  
  74.      GET <filespec> [uue[ncode] | xxe[ncode]]
  75.  
  76. <filespec> is required. <filespec> must specify a path, but
  77. without a drive specification. The filespec is not relative to
  78. any directory. Unlike interactive waffle, where the user is
  79. placed in the directory defined by Waffle's "files" static file
  80. statement, WFS has no default starting directory.
  81.  
  82. uuencode or xxencode is optional and may be abreviated as "uue"
  83. or "xxe", respectively. If neither are specified, the file is
  84. sent according to the rules for sending files set by the system
  85. administrator. That is: the system administrator may define a
  86. list of file extensions that will always be uuencoded for
  87. transmission; also the system administrator may define a file
  88. size limit such that any file larger than this limit will be
  89. uuencoded for transmission.
  90.  
  91. If uuencode is specified, the file is sent uuencoded.
  92.  
  93. If xxencode is specified, the file is sent xxencoded.
  94.  
  95. For example:
  96.  
  97.      GET /public/wfs110.zip
  98.      GET /public/waffle/waf165.zip
  99.  
  100. are syntactically correct.
  101.  
  102.      GET c:/autoexec.bat
  103.      GET e:/wfs/src/wfsreqst.c
  104.  
  105. are not syntactically correct; both incorrect examples have a
  106. drive specifier.
  107.  
  108.      GET autoexec.bat
  109.      GET src/wfsreqst.c
  110.  
  111. are not correct. Both do not specify the leading slash.
  112.  
  113. The SysOp may selectively enable and optionally assign multiple
  114. aliases for the GET command using the wfs.enable.get static file
  115. statement.
  116.  
  117.  
  118. 2.5  The PING Command
  119.  
  120. The PING command causes WFS make a simple reply, via the session
  121. transcript, to the requestor. To test the path to a WFS at a
  122. site, send the PING command.
  123.  
  124. The SysOp may selectively enable and optionally assign multiple
  125. aliases for the PING command using the wfs.enable.ping static
  126. file statement.
  127.  
  128.  
  129. 2.6  The QUIT Command
  130.  
  131. The word "quit" as the first token on a line causes WFS to quit
  132. processing input as if end of input had occurred.
  133.  
  134. The SysOp may selectively enable and optionally assign multiple
  135. aliases for the QUIT command using the wfs.enable.quit static
  136. file statement.
  137.  
  138.  
  139. 2.7  The PASSWORD Command
  140.  
  141. The SysOp defined commands require the user to specify a password
  142. in the incomming message before invoking the SysOp defined
  143. command. The syntax for the PASSWORD command is:
  144.  
  145.      password <string>
  146.  
  147. Where string is the password for the SysOp defined command that
  148. will appear in the input stream. The operand of the PASSWORD
  149. command is case sensitive.
  150.  
  151. The SysOp may selectively enable and optionally assign multiple
  152. aliases for the PASSWORD command using the wfs.enable.password
  153. static file statement.
  154.  
  155.  
  156. 2.8  SysOp Defined Commands
  157.  
  158. The SysOp may define commands unique to this site.
  159.  
  160. SysOp, please see "Command Execution Facility" on page 34 for a
  161. description of this feature.
  162.  
  163.  
  164. 2.9  About Mailing Lists
  165.  
  166. When configured to operate as a mailing list processor, WFS
  167. accepts mail list commands at the same "address" it accepts
  168. archive server commands. Messages that are to be propogated to
  169. the members of a mailing list must use a separate address.
  170.  
  171. For example: if you have configured WFS to accept commands at
  172. "file-request@FroBaz.com", then all of the mail list commands are
  173. processed when those commands are directed to that address.
  174.  
  175. If you have defined a mail list as "test-list" then to forward a
  176. message to all subscribers to a list, mail must be addressed to
  177. "test-list@FroBaz.com".
  178.  
  179.  
  180. 2.10  The JOIN Command
  181.  
  182. The JOIN command causes WFS to add the originator of the email to
  183. a mailing list.
  184.  
  185. The syntax for the JOIN command is:
  186.  
  187.      join <listname>
  188.  
  189. Where <listname> is the name of the mailing list. For example, if
  190. a subscriber wants to mail to all subscribers, then addresses
  191. mail as:
  192.  
  193.      test-list@FroBaz.com
  194.  
  195. Then to subscribe to the mailing list, he would say:
  196.  
  197.      join test-list
  198.  
  199. The syntax of the other mail list commands is similar.
  200.  
  201. The SysOp may selectively enable and optionally assign multiple
  202. aliases for the JOIN command using the wfs.enable.subscribe
  203. static file statement.
  204.  
  205.  
  206. 2.11  The UNJOIN Command
  207.  
  208. The UNJOIN command causes WFS to remove the originator of the
  209. email from a mailing list.
  210.  
  211. The syntax for the UNJOIN command is:
  212.  
  213.      unjoin <listname>
  214.  
  215. The SysOp may selectively enable and optionally assign multiple
  216. aliases for the UNJOIN command using the wfs.enable.unsubscribe
  217. static file statement.
  218.  
  219.  
  220. 2.12  The ARCHIVE Command
  221.  
  222. The ARCHIVE command causes WFS to send all archived messages for
  223. the named mailing list to the requestor. The request is queued
  224. for subsequent processing.
  225.  
  226. The syntax for the ARCHIVE command is:
  227.  
  228.      archive <listname>
  229.  
  230. The SysOp may selectively enable and optionally assign multiple
  231. aliases for the ARCHIVE command using the wfs.enable.archive
  232. static file statement.
  233.  
  234.  
  235. 2.13  The MEMBERS Command
  236.  
  237. The MEMBERS command causes WFS to send a list of all members
  238. (subscribers) to the originator of this message.
  239.  
  240.      members <listname>
  241.  
  242. The SysOp may selectively enable and optionally assign multiple
  243. aliases for the MEMBERS command using the wfs.enable.members
  244. static file statement.
  245.  
  246.